<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Transcoder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/azeckoski/reflectutils/transcoders/Transcoder.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: Transcoder.html 10 2008-10-01 10:56:15Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://reflectutils.googlecode.com/svn/maven/site/xref/org/azeckoski/reflectutils/transcoders/Transcoder.html $</em>
<a name="4" href="#4">4</a>   <em> * Transcoder.java - entity-broker - Sep 16, 2008 3:20:14 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski @ gmail.com) (aaronz @ vt.edu) (aaron @ caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.azeckoski.reflectutils.transcoders;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.util.Map;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <em>/**<em>*</em></em>
<a name="23" href="#23">23</a>  <em> * The transcoder can convert from a java objects => a format => java objects (simple) &lt;br/></em>
<a name="24" href="#24">24</a>  <em> * Note that conversion to simple objects is all that is generally supported,</em>
<a name="25" href="#25">25</a>  <em> * conversions to complex objects require use of the {@link ReflectUtils} to handle</em>
<a name="26" href="#26">26</a>  <em> * the conversion using {@link ReflectUtils#populate(Object, Map)} or {@link ReflectUtils#convert(Object, Class)}</em>
<a name="27" href="#27">27</a>  <em> * &lt;br/></em>
<a name="28" href="#28">28</a>  <em> * The ability to append optional properties is also supported &lt;br/></em>
<a name="29" href="#29">29</a>  <em> * The various transcoders will also have optional configuration parameters which should be controlled</em>
<a name="30" href="#30">30</a>  <em> * via the constructors. &lt;br/></em>
<a name="31" href="#31">31</a>  <em> * Transcoders should be written to be created once and used many times without problems.</em>
<a name="32" href="#32">32</a>  <em> * </em>
<a name="33" href="#33">33</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="34" href="#34">34</a>  <em> */</em>
<a name="35" href="#35">35</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/azeckoski/reflectutils/transcoders/Transcoder.html">Transcoder</a> {
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>      <em>/**<em>*</em></em>
<a name="38" href="#38">38</a>  <em>     * default map key to use if the output data is not actually a map but is a list or array or whatever</em>
<a name="39" href="#39">39</a>  <em>     * when it is being decoded into a map</em>
<a name="40" href="#40">40</a>  <em>     */</em>
<a name="41" href="#41">41</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String DATA_KEY = <span class="string">"data"</span>;
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>      <em>/**<em>*</em></em>
<a name="44" href="#44">44</a>  <em>     * @return the handled format (xml, json, etc.)</em>
<a name="45" href="#45">45</a>  <em>     */</em>
<a name="46" href="#46">46</a>      <strong>public</strong> String getHandledFormat();
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>      <em>/**<em>*</em></em>
<a name="49" href="#49">49</a>  <em>     * @param object any java object (should not be null)</em>
<a name="50" href="#50">50</a>  <em>     * @param name (optional) the name of the data, will be handled differently by the encoders (null for default: {@link #DATA_KEY})</em>
<a name="51" href="#51">51</a>  <em>     * @param properties (optional) additional properties which will be added to the encoding </em>
<a name="52" href="#52">52</a>  <em>     * as if it were a property of the bean or map being encoded, if the object being encoded is not a bean</em>
<a name="53" href="#53">53</a>  <em>     * or a map then the properties are ignored</em>
<a name="54" href="#54">54</a>  <em>     * @return the object encoded into the handled format</em>
<a name="55" href="#55">55</a>  <em>     */</em>
<a name="56" href="#56">56</a>      <strong>public</strong> String encode(Object object, String name, Map&lt;String, Object> properties);
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em>/**<em>*</em></em>
<a name="59" href="#59">59</a>  <em>     * Decode the data string into a map of java objects (typically simple objects like String, Integer, etc.)</em>
<a name="60" href="#60">60</a>  <em>     * @param string a string in the handled format</em>
<a name="61" href="#61">61</a>  <em>     * @return the map of java objects based on the data string, this will not attempt to convert XML into beans</em>
<a name="62" href="#62">62</a>  <em>     * but will simply convert data into maps or lists or simple java objects (strings, etc.), if there</em>
<a name="63" href="#63">63</a>  <em>     * is only a single simple value then it will be placed into the map with the key {@value #DATA_KEY}</em>
<a name="64" href="#64">64</a>  <em>     */</em>
<a name="65" href="#65">65</a>      <strong>public</strong> Map&lt;String, Object> decode(String string);
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

